home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Cream of the Crop 21
/
Cream of the Crop 21 (Terry Blount) (October 1996).iso
/
editor
/
wf314.zip
/
WF311DOC.ZIP
/
DOCS
/
WF.015
< prev
next >
Wrap
Text File
|
1992-01-31
|
12KB
|
342 lines
.f3 - # - Chapter 15 - Indexing
.rm70
.tc
.tc 15. INDEXING ..........................................#
CHAPTER 15 INDEXING
.IMIndexing
An index is an alphabetic listing of topics in the text, each with a
list of page numbers where the phrase can be found. Word Fugue can
create document indexes.
.tc Specifying Index Entries ...........................#
Specifying Index Entries
.ix Marking with .IX command
.ix Marking with ^K command
.ix Specifying index entries
.ixDot Commands; .IX - Index Entry
Individual words and phrases can be marked in the text by pressing
Ctrl P K before and after the phrase you want to include in the index.
For example:
This paragraph explains about ^K indexing documents^K
The bracketing ^Ks do not print, they are only there to mark an index
entry. Any characters between the two markers will be included in the
index when it is generated.
You can also enter a word or phrase by using the .IX dot command. The
dot must appear in the first column. For example:
.IX indexing documents
In either case, the maximum length of an index phrase is 50
characters, and is counted from the first character following the .ix
or the ^K. Extra characters are ignored. In each case, the same phrase
indexing documents will be included in the index, with a leading
space.
You will be prompted for the name of the file to generate the index
for. If you elect to use the same name as the file you are editing,
Word Fugue will use the disk version of the file.
.ix File name used
The output file name will be that of the input file name, with the
extension set to .IDX
.ix Major heading prefix
To assist sorting of index entries, you can create major headings by
prefixing the index entry by the major heading, followed by a
semicolon ';'. These major sort keys are limited to 14 characters.
When you use major heading, you can still have 50 characters for the
index entry (counted from the first character after the semicolon).
.tc Generating an Index ................................#
Generating an Index
.ix Generation of
Press Ctrl F6 to commence the operation. Word Fugue will prompt you with
Enter file name to index
The file name will default to the last entry for editing, and may
contain wild cards if that was how you selected your last file for
editing. When you enter a file name, Word Fugue will generate an index.
If you press enter with wild cards showing ('*' or '?'), you will see
a picklist from which to select your file. You can cancel the
operation by pressing ESC at the prompt. In addition, you can abort
the index operation part way through by pressing the abort command ^U.
.CP15
It typically takes about 1 second per page on a slow 4.7Mhz IBM or
clone, and the message Working is displayed on the top line. The
generation will use the file(s) on disk, so be sure to save the file
you are editing so that the latest changes will be included in your
index. During generation, each index entry occupies about 80
characters of memory,Thus, if you are editing a large document, you
may run out of memory. In this case, close all files to free up
memory, and do the index operation when you are editing a blank file,
or exit re-enter with an empty file.
.ix Memory usage
.ix Working with large documents
.ixTIPS; Indexing the chapters of a book
.ixTIPS; Break Large documents into chapters
TIP - if you are writing a book or similar, with several chapters, set
each chapter up as a separate file, and create a master file
that includes each chapter, table of contents & index file by
use of .FI commands. Generate the index for the top level file,
and all lower level files will be included.
.tc Sample Input and Output ............................#
Sample Input and Output
.IMIndexing
.ix Specifying index entries
Given this simple input:
.ix Indexing; Generation
.ix Indexing; Specifying Entries
.ix Indexing;Indexing
appearing on several pages of the document, the indexing operation
will produce the following output:
Indexing, 2-4,6
Generation, 2-4,6
Specifying Entries, 2-4,6
where the figures appearing after the index text are the page
references. Each entry is sorted alphabetically, but upper and lower
case are ignored. To sort various entries together, you should
prefix them all with the same major heading, as shown above.
Please note that spaces following after the .IX command are
significant, and will be used as part of the sort key.
This process can be made more easy by use of Index Major entries.
.tc Index Major Entries ................................#
Index Major Entries
.ix Marking with .IM command
.ixDot Commands; .IM - Index Major heading
If you prefer a more tarted up output produced automatically, you can
specify the sort prefix for index entries by use of the .IM command to
set a major heading for index entries. The text following the .IM
command will appear in the index, and will also be used as a sort
prefix for subsequent .IX commands and text between ^K markers. The
same prefix will be used for all index entries until the appearance of
another .IM command.
.CP6
The example above could be re-written as:
.im INDEXING
.ix Specifying Entries
.ix Generation
.CP5
and would produce:
INDEXING
Generation, 2-4,6
Specifying Entries, 2-4,6
The difference between this and the previous example using prefixes is
that .IM entries are index entries in their own right, while the major
heading prefixes in .IX and ^K entries do not appear in the index, but
are used merely for sequencing or sorting of the index entries. In
addition, Index Major entries do not have page references generated
for them.
When using .IM entries, the text is restricted to 50 characters
following the .IM, as for .IX entries. The first 14 characters of the
.IM entry is used for sequencing or sorting, as with the prefix
method.
Please note that spaces following the .IM command are significant, and
will be used as part of the sort key.
.IMIndexing
.ix Specifying index entries
You can also include font commands to make the entries bold, italic,
double height or width etc.
The format of the output is as shown above - each entry occupies 2
lines, the first for the entry, the second for the page number
references separated by commas. Note that if 3 or more consecutive
page numbers are found, they are abbreviated to the first and last
number, separated by a hyphen.
Thus pages 2, 3, 6 and 7 would appear
2,3,6,7
while pages 2, 3, 4, 5, 9, 10, 11 and 15 would appear as
2-5,9-11,15
.tc Index Refer to Entries .............................#
Index Refer To Entries
.ix Marking with .IR command
.ixDot Commands; .IR - Index Refer to
Sometimes you need to insert index entries under a topic heading with
only a "Refer to ..." entry. In this case you do not want that line
having a page reference. For this you can use the .IR command, which
is otherwise identical to the .IX command.
For example:
.im INDEXING
.ix Specifying Entries
.ix Generation
.ir See also Table of Contents
and would produce:
INDEXING
Generation, 2-4,6
See also Table of Contents
Specifying Entries, 2-4,6
.CP10
.tc Width of the Index Line ............................#
Width of the Index Line
.ix Width of Index Line (.IW)
.ixDot Commands; .IW - Index Width
Defaults
The default width of the index line is 65 characters